Add note about comments in .env files #3403
Closed
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
You can put "comments" in .env files, because lines that don't start with letters or numbers are ignored - see here for the code that reads these files.
I'm not sure if this constitutes "official" support for comments in .env files or not - or if it's just taking advantage of an implementation detail.
Either way, I wanted to put comments into this file, so this was useful information to me - and something that I had to figure out myself.
This commit adds a note about this to the docs, using the
#
to denote a comment line - although any non-alphanumeric char would work.